Update Orleans and Aspire integration documentation#54201
Conversation
.NET Aspire -> Aspire
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the Orleans hosting documentation to reflect “Aspire” (vs “.NET Aspire”) terminology and refreshes related setup links.
Changes:
- Renamed headings/front-matter to “Orleans and Aspire integration”.
- Updated external/reference links (aspire.dev, VS Code extension link).
- Adjusted wording in pivoted sections to use “Aspire” terminology.
| title: Orleans and Aspire integration | ||
| description: Learn how to integrate Orleans with Aspire for cloud-native development. |
| --- | ||
|
|
||
| # Orleans and .NET Aspire integration | ||
| # Orleans and Aspire integration |
| ## Overview | ||
|
|
||
| Orleans integration with .NET Aspire uses the `Aspire.Hosting.Orleans` package in your AppHost project. This package provides extension methods to: | ||
| Orleans integration with Aspire uses the `Aspire.Hosting.Orleans` package in your AppHost project. This package provides extension methods to: |
| :::zone target="docs" pivot="orleans-8-0,orleans-9-0,orleans-10-0" | ||
|
|
||
| [.NET Aspire](/dotnet/aspire/get-started/aspire-overview) provides a streamlined approach to building cloud-native applications with built-in support for Orleans. Starting with Orleans 8.0, you can use Aspire to orchestrate your Orleans cluster, manage backing resources (like Redis or Azure Storage), and automatically configure service discovery, observability, and health checks. | ||
| [Aspire](https://aspire.dev/integrations/frameworks/orleans) provides a streamlined approach to building cloud-native applications with built-in support for Orleans. Starting with Orleans 8.0, you can use Aspire to orchestrate your Orleans cluster, manage backing resources (like Redis or Azure Storage), and automatically configure service discovery, observability, and health checks. |
|
|
||
| - [.NET Aspire overview](/dotnet/aspire/get-started/aspire-overview) | ||
| - [.NET Aspire setup and tooling](/dotnet/aspire/fundamentals/setup-tooling) | ||
| - [Aspire overview](https://aspire.dev/get-started/prerequisites/) |
| - [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) or later | ||
| - [.NET Aspire workload](/dotnet/aspire/fundamentals/setup-tooling) | ||
| - An IDE with Aspire support (Visual Studio 2022 17.9+, VS Code with C# Dev Kit, or JetBrains Rider) | ||
| - [Aspire cli](https://aspire.dev/get-started/install-cli/) |
| :::zone target="docs" pivot="orleans-3-x" | ||
|
|
||
| .NET Aspire integration is available in Orleans 8.0 and later. Orleans 3.x does not support .NET Aspire. | ||
| Aspire integration is available in Orleans 8.0 and later. Orleans 3.x does not support .NET Aspire. |
dotnet-policy-service
Bot
added
the
community-contribution
|
@Meir017, I agree with the Copilot suggestions. Here are the issues and fixes: Issue 1: Branding inconsistency
Fix: Keep ".NET Aspire" as the primary name throughout the document. If shorthand is needed, add "(Aspire)" after first mention, e.g., ".NET Aspire (hereafter referred to as Aspire)". Issue 2: External links vs internal links Fix: Restore the Microsoft Learn links for consistency, localization, and long-term stability. Use aspire.dev only for content that doesn't exist on Microsoft Learn. Issue 3: Capitalization Issue 4: Mixed terminology in pivot section Summary of changes needed: | Title | "Orleans and Aspire integration" | "Orleans and .NET Aspire integration" | I can help create a PR with these fixes if needed. |
|
The official name is Aspire, not .NET Aspire |
.NET Aspire -> Aspire
Summary
FYI @IEvangelist @davidfowl